<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupProxyURIResolver</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch03.html" title="Additional Features">
<link rel="prev" href="SoupLogger.html" title="SoupLogger">
<link rel="next" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="SoupLogger.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libsoup Reference Manual</th>
<td><a accesskey="n" href="SoupProxyResolverDefault.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#SoupProxyURIResolver.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#SoupProxyURIResolver.description" class="shortcut">Description</a>
                   | 
                  <a href="#SoupProxyURIResolver.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#SoupProxyURIResolver.prerequisites" class="shortcut">Prerequisites</a>
                   | 
                  <a href="#SoupProxyURIResolver.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="SoupProxyURIResolver"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupProxyURIResolver.top_of_page"></a>SoupProxyURIResolver</span></h2>
<p>SoupProxyURIResolver</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="SoupProxyURIResolver.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libsoup/soup.h&gt;

                    <a class="link" href="SoupProxyURIResolver.html#SoupProxyURIResolver-struct" title="SoupProxyURIResolver">SoupProxyURIResolver</a>;
<span class="returnvalue">void</span>                (<a class="link" href="SoupProxyURIResolver.html#SoupProxyURIResolverCallback" title="SoupProxyURIResolverCallback ()">*SoupProxyURIResolverCallback</a>)     (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *resolver</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *proxy_uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupProxyURIResolver.html#soup-proxy-uri-resolver-get-proxy-uri-async" title="soup_proxy_uri_resolver_get_proxy_uri_async ()">soup_proxy_uri_resolver_get_proxy_uri_async</a>
                                                        (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *proxy_uri_resolver</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html#SoupProxyURIResolverCallback" title="SoupProxyURIResolverCallback ()"><span class="type">SoupProxyURIResolverCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="SoupProxyURIResolver.html#soup-proxy-uri-resolver-get-proxy-uri-sync" title="soup_proxy_uri_resolver_get_proxy_uri_sync ()">soup_proxy_uri_resolver_get_proxy_uri_sync</a>
                                                        (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *proxy_uri_resolver</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> **proxy_uri</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="SoupProxyURIResolver.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----SoupProxyURIResolver
</pre>
</div>
<div class="refsect1">
<a name="SoupProxyURIResolver.prerequisites"></a><h2>Prerequisites</h2>
<p>
SoupProxyURIResolver requires
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="SoupProxyURIResolver.implementations"></a><h2>Known Implementations</h2>
<p>
SoupProxyURIResolver is implemented by
 <a class="link" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault">SoupProxyResolverDefault</a>.</p>
</div>
<div class="refsect1">
<a name="SoupProxyURIResolver.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="SoupProxyURIResolver.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SoupProxyURIResolver-struct"></a><h3>SoupProxyURIResolver</h3>
<pre class="programlisting">typedef struct _SoupProxyURIResolver SoupProxyURIResolver;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupProxyURIResolverCallback"></a><h3>SoupProxyURIResolverCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*SoupProxyURIResolverCallback)     (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *resolver</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> status</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *proxy_uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Callback for <a class="link" href="SoupProxyURIResolver.html#soup-proxy-uri-resolver-get-proxy-uri-async" title="soup_proxy_uri_resolver_get_proxy_uri_async ()"><code class="function">soup_proxy_uri_resolver_get_proxy_uri_async()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>resolver</code></em> :</span></p></td>
<td>the <a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>a <a class="link" href="libsoup-2.4-soup-status.html#SoupKnownStatusCode" title="enum SoupKnownStatusCode"><span class="type">SoupKnownStatusCode</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy_uri</code></em> :</span></p></td>
<td>the resolved proxy URI, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data passed to <a class="link" href="SoupProxyURIResolver.html#soup-proxy-uri-resolver-get-proxy-uri-async" title="soup_proxy_uri_resolver_get_proxy_uri_async ()"><code class="function">soup_proxy_uri_resolver_get_proxy_uri_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="soup-proxy-uri-resolver-get-proxy-uri-async"></a><h3>soup_proxy_uri_resolver_get_proxy_uri_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_proxy_uri_resolver_get_proxy_uri_async
                                                        (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *proxy_uri_resolver</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html#SoupProxyURIResolverCallback" title="SoupProxyURIResolverCallback ()"><span class="type">SoupProxyURIResolverCallback</span></a> callback</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Asynchronously determines a proxy URI to use for <em class="parameter"><code>msg</code></em> and calls
<em class="parameter"><code>callback</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy_uri_resolver</code></em> :</span></p></td>
<td>the <a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> you want a proxy for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>async_context</code></em> :</span></p></td>
<td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to invoke <em class="parameter"><code>callback</code></em> in. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>callback to invoke with the proxy address. <span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data for <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26.3</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-proxy-uri-resolver-get-proxy-uri-sync"></a><h3>soup_proxy_uri_resolver_get_proxy_uri_sync ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               soup_proxy_uri_resolver_get_proxy_uri_sync
                                                        (<em class="parameter"><code><a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a> *proxy_uri_resolver</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> **proxy_uri</code></em>);</pre>
<p>
Synchronously determines a proxy URI to use for <em class="parameter"><code>uri</code></em>. If <em class="parameter"><code>uri</code></em>
should be sent via proxy, *<em class="parameter"><code>proxy_uri</code></em> will be set to the URI of the
proxy, else it will be set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy_uri_resolver</code></em> :</span></p></td>
<td>the <a class="link" href="SoupProxyURIResolver.html" title="SoupProxyURIResolver"><span class="type">SoupProxyURIResolver</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>the <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> you want a proxy for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>proxy_uri</code></em> :</span></p></td>
<td>on return, will contain the proxy URI. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a> if successful, or a transport-level
error.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.26.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>